GermanWikipedia - /page/entry.mu

Micron Document

<!DOCTYPE html>

<title>OpenAPI</title>

</head>

<h1 id="firstHeading" class="firstHeading mw-first-heading"><span class="mw-page-title-main">OpenAPI</span></h1>

</header>

</div>

<div id="mw-content-text" class="mw-body-content mw-content-ltr" lang="de" dir="ltr"><div class="mw-content-ltr mw-parser-output" lang="de" dir="ltr"><p>Die <b>OpenAPI Specification</b> (OAS) ist eine quelloffene, herstellerunabhängige Spezifikation innerhalb der <b>OpenAPI Initiative</b> und ein Projekt der <a href="Linux_Foundation" title="Linux Foundation">Linux Foundation</a>. OAS definiert einen programmiersprachen-unabhängigen Standard zur Beschreibung von <a href="Hypertext_Transfer_Protocol" title="Hypertext Transfer Protocol">HTTP</a>-<a href="Programmierschnittstelle" title="Programmierschnittstelle">Programmierschnittstellen (APIs)</a>. Dies soll sowohl Menschen als auch Maschinen ermöglichen, die Möglichkeiten einer Schnittstelle zu entdecken und zu verstehen, ohne die Notwendigkeit auf zusätzliche Dokumentation, <a href="Quelltext" title="Quelltext">Quellcode</a> oder Analyse von Netzwerkverkehr zurückzugreifen. Der Nutzer der API soll damit in die Lage versetzt werden, mit minimalem Implementierungsaufwand mit der Schnittstelle zu interagieren.

</p><p>Anwendungsbeispiele sind interaktive Dokumentationen, Code-Generierung und Test-Automatisierung.

</p><p>OAS erfordert keine Änderungen an existierenden APIs, die Beschreibung muss nicht zwingend vom Ersteller der API zur Verfügung gestellt werden. Es können allerdings nicht alle Arten von HTTP-Schnittstellen mit OAS beschrieben werden. <a href="Representational_State_Transfer" title="Representational State Transfer">REST</a>-konforme Schnittstellen werden unterstützt.<sup id="cite_ref-1" class="reference"><a href="#cite_note-1"><span class="cite-bracket">[</span>1<span class="cite-bracket">]</span></a></sup> Für asynchrone API-Kommunikation mit unterschiedlichen Transportprotokollen ist AsyncAPI als Beschreibungsstandard entstanden, der sich am OpenAPI-Konzept anlehnt.<sup id="cite_ref-heise-2022-12-16_2-0" class="reference"><a href="#cite_note-heise-2022-12-16-2"><span class="cite-bracket">[</span>2<span class="cite-bracket">]</span></a></sup>

</p>

<div class="mw-heading mw-heading2"><h2 id="Geschichte">Geschichte</h2></div>

<p>Die OpenAPI-Specification begann als Teil des Softwareprojekts <a href="Swagger_(Software)" title="Swagger (Software)">Swagger</a>, einem <a href="Open_Source" title="Open Source">Open-Source</a>-<a href="Framework" title="Framework">Framework</a> für <a href="HTTP" class="mw-redirect" title="HTTP">HTTP</a>-<a href="Webservice" title="Webservice">Webservices</a>. Im Jahr 2016 wurde sie ein eigenständiges Projekt, das von der <i>OpenAPI Initiative</i> verwaltet wird, zu deren Mitgliedern Unternehmen wie <a href="Atlassian" title="Atlassian">Atlassian</a>, <a href="Google_LLC" title="Google LLC">Google</a>, <a href="IBM" title="IBM">IBM</a>, <a href="Microsoft" title="Microsoft">Microsoft</a>, <a href="PayPal" title="PayPal">PayPal</a> und <a href="SAP" title="SAP">SAP</a> zählen.<sup id="cite_ref-3" class="reference"><a href="#cite_note-3"><span class="cite-bracket">[</span>3<span class="cite-bracket">]</span></a></sup>

</p><p>Die aktuelle Version der OpenAPI-Specification ist 3.1.0.<sup id="cite_ref-4" class="reference"><a href="#cite_note-4"><span class="cite-bracket">[</span>4<span class="cite-bracket">]</span></a></sup>

</p>

<div class="mw-heading mw-heading2"><h2 id="Werkzeuge">Werkzeuge</h2></div>

<div class="hauptartikel" role="navigation"><span class="hauptartikel-pfeil" title="siehe" aria-hidden="true" role="presentation">→ </span><i><span class="hauptartikel-text">Hauptartikel</span>: <a href="Swagger_(Software)" title="Swagger (Software)">Swagger (Software)</a></i></div>

<p>Swagger bietet eine Sammlung von <a href="Open_Source" title="Open Source">Open-Source</a>-Werkzeugen, um APIs zu entwickeln, die konform zur OpenAPI-Spezifikation sind:<sup id="cite_ref-5" class="reference"><a href="#cite_note-5"><span class="cite-bracket">[</span>5<span class="cite-bracket">]</span></a></sup>

</p>

<dl><dt>Swagger Editor</dt>

<dd>unterstützt beim Erzeugen der API-Definition</dd>

<dt>Swagger Codegen</dt>

<dd>generiert Server <a href="Stub_(Programmierung)" title="Stub (Programmierung)">Stubs</a> und <a href="Client" title="Client">Client</a> SDKs</dd>

<dt>Swagger UI</dt>

<dd>erzeugt Dokumentation</dd></dl>

<p>Daneben existieren auch kostenpflichtige Werkzeuge:

</p>

<dl><dt>SwaggerHub</dt>

<dd>für Kollaboration</dd>

<dt>SwaggerHub Enterprise</dt>

<dd>für Unternehmen, verfügbar in der Cloud oder On-Premises</dd>

<dt>Swagger Inspector</dt>

<dd>für Testzwecke</dd>

<dt>APITree</dt>

<dd>wandelt OpenAPI-Spezifikationen 2.0 und 3.0 in menschenlesbare API-Dokumentationen um, die über einen HUB kostenlos in der Cloud verwaltet und geteilt werden können.</dd></dl>

<p>Auch für verschiedene Entwicklungsumgebungen existieren Erweiterungen zur Unterstützung von OpenAPI.<sup id="cite_ref-6" class="reference"><a href="#cite_note-6"><span class="cite-bracket">[</span>6<span class="cite-bracket">]</span></a></sup><sup id="cite_ref-7" class="reference"><a href="#cite_note-7"><span class="cite-bracket">[</span>7<span class="cite-bracket">]</span></a></sup>

</p>

<div class="mw-heading mw-heading2"><h2 id="Literatur">Literatur</h2></div>

<ul><li>Stefan Sauterleute, Michael Heiß, Christopher Köster: <cite style="font-style:italic">Einstieg in OpenAPI v3: REST wird erwachsen</cite>. In: <cite style="font-style:italic">Entwickler Magazin</cite>. <span style="white-space:nowrap">Nr.<span style="display:inline-block;width:.2em"> </span>1</span>, 2018, <span style="white-space:nowrap">S.<span style="display:inline-block;width:.2em"> </span>?</span> (<a rel="nofollow" class="external text" href="https://kiosk.entwickler.de/entwickler-magazin/entwickler-magazin-1-2018/einstieg-in-openapi-v3/">entwickler.de</a> [abgerufen am 24. Februar 2020] <a rel="nofollow" class="external text" href="https://entwickler.de/online/development/einstieg-in-openapi-v3-579830417.html">Kostenlose Onlineversion</a>).<span class="Z3988" title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rfr_id=info:sid/de.wikipedia.org:OpenAPI&rft.atitle=Einstieg+in+OpenAPI+v3%3A+REST+wird+erwachsen&rft.au=Stefan+Sauterleute%2C+Michael+Hei%C3%9F%2C+Christopher+K%C3%B6ster&rft.date=2018&rft.genre=journal&rft.issue=1&rft.jtitle=Entwickler+Magazin&rft.pages=%3F" style="display:none"> </span></li></ul>

<ul><li>Manuel Ottlik: <cite style="font-style:italic">REST-APIs dokumentieren nach OpenAPI-Standard</cite>. In: <cite style="font-style:italic"><a href="C%E2%80%99t" title="C’t">c’t</a></cite>. <span style="white-space:nowrap">Nr.<span style="display:inline-block;width:.2em"> </span>5</span>, 2020, <span style="white-space:nowrap">S.<span style="display:inline-block;width:.2em"> </span>136–139</span> (<a rel="nofollow" class="external text" href="https://shop.heise.de/katalog/schnittstellen-erklarer">heise.de</a> [abgerufen am 22. Februar 2020]).<span class="Z3988" title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rfr_id=info:sid/de.wikipedia.org:OpenAPI&rft.atitle=REST-APIs+dokumentieren+nach+OpenAPI-Standard&rft.au=Manuel+Ottlik&rft.date=2020&rft.genre=journal&rft.issue=5&rft.jtitle=c%E2%80%99t&rft.pages=136-139" style="display:none"> </span></li></ul>

<div class="mw-heading mw-heading2"><h2 id="Weblinks">Weblinks</h2></div>

<ul><li><a rel="nofollow" class="external text" href="https://www.openapis.org">openapis.org</a> – Offizielle Website der OpenAPI Initiative</li>

<li><a rel="nofollow" class="external text" href="https://github.com/OAI/OpenAPI-Specification">OpenAPI</a> auf <a href="GitHub" title="GitHub">GitHub</a></li></ul>

<p><b>Beispiele:</b>

</p>

<ul><li><a rel="nofollow" class="external text" href="https://petstore.swagger.io/">petstore.swagger.io</a> – fiktiver Server zur Demonstration von OpenAPI</li>

<li><a rel="nofollow" class="external text" href="https://hub.apitree.com">hub.apitree.com</a> – Öffentliches Verzeichnis von OpenAPI-Projekten mit interaktiven Beispielen</li>

<li><a rel="nofollow" class="external text" href="https://github.com/microsoft/OpenAPI.NET">github.com/…</a> – OpenAPI Dokumente in .NET</li></ul>

<div class="mw-heading mw-heading2"><h2 id="Einzelnachweise">Einzelnachweise</h2></div>

<li id="cite_note-1"><span class="mw-cite-backlink"><a href="#cite_ref-1">↑</a></span> <span class="reference-text"><span class="cite"><a rel="nofollow" class="external text" href="https://github.com/OAI/OpenAPI-Specification/tree/main"><i>OAI/OpenAPI-Specification.</i></a> OpenAPI Initiative, 13. September 2024,<span class="Abrufdatum"> abgerufen am 13. September 2024</span>.</span><span style="display: none;" class="Z3988" title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adc&rfr_id=info%3Asid%2Fde.wikipedia.org%3AOpenAPI&rft.title=OAI%2FOpenAPI-Specification&rft.description=OAI%2FOpenAPI-Specification&rft.identifier=https%3A%2F%2Fgithub.com%2FOAI%2FOpenAPI-Specification%2Ftree%2Fmain&rft.publisher=OpenAPI+Initiative&rft.date=2024-09-13"> </span></span>

</li>

<li id="cite_note-heise-2022-12-16-2"><span class="mw-cite-backlink"><a href="#cite_ref-heise-2022-12-16_2-0">↑</a></span> <span class="reference-text">Thilo Frotscher: <a rel="nofollow" class="external text" href="https://heise.de/-7396398"><span style="font-style:italic;">AsyncAPI: Asynchrone Kommunikation für IoT und Microservices meistern.</span></a> In: <i><a href="Heise_online" title="Heise online">Heise online</a>.</i> <span style="white-space:nowrap;">16. Dezember 2022</span>. Abgerufen am 18. Dezember 2022.</span>

</li>

<li id="cite_note-3"><span class="mw-cite-backlink"><a href="#cite_ref-3">↑</a></span> <span class="reference-text"><span class="cite"><a rel="nofollow" class="external text" href="https://www.openapis.org/membership/members"><i>Mitglieder der OpenAPI Initiative.</i></a><span class="Abrufdatum"> Abgerufen am 30. Dezember 2019</span>.</span><span style="display: none;" class="Z3988" title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adc&rfr_id=info%3Asid%2Fde.wikipedia.org%3AOpenAPI&rft.title=Mitglieder+der+OpenAPI+Initiative&rft.description=Mitglieder+der+OpenAPI+Initiative&rft.identifier=https%3A%2F%2Fwww.openapis.org%2Fmembership%2Fmembers"> </span></span>

</li>

<li id="cite_note-4"><span class="mw-cite-backlink"><a href="#cite_ref-4">↑</a></span> <span class="reference-text"><span class="cite"><a rel="nofollow" class="external text" href="https://github.com/OAI/OpenAPI-Specification/releases"><i>Releases der OpenAPI-Specification.</i></a><span class="Abrufdatum"> Abgerufen am 24. September 2020</span>.</span><span style="display: none;" class="Z3988" title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adc&rfr_id=info%3Asid%2Fde.wikipedia.org%3AOpenAPI&rft.title=Releases+der+OpenAPI-Specification&rft.description=Releases+der+OpenAPI-Specification&rft.identifier=https%3A%2F%2Fgithub.com%2FOAI%2FOpenAPI-Specification%2Freleases"> </span></span>

</li>

<li id="cite_note-5"><span class="mw-cite-backlink"><a href="#cite_ref-5">↑</a></span> <span class="reference-text"><span class="cite"><a rel="nofollow" class="external text" href="https://swagger.io/tools/open-source/"><i>OpenAPI Open-Source Werkzeuge.</i></a><span class="Abrufdatum"> Abgerufen am 30. Dezember 2019</span>.</span><span style="display: none;" class="Z3988" title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adc&rfr_id=info%3Asid%2Fde.wikipedia.org%3AOpenAPI&rft.title=OpenAPI+Open-Source+Werkzeuge&rft.description=OpenAPI+Open-Source+Werkzeuge&rft.identifier=https%3A%2F%2Fswagger.io%2Ftools%2Fopen-source%2F"> </span></span>

</li>

<li id="cite_note-6"><span class="mw-cite-backlink"><a href="#cite_ref-6">↑</a></span> <span class="reference-text"><span class="cite"><a rel="nofollow" class="external text" href="https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi"><i>OpenAPI-Editor für Visual Studio Code.</i></a><span class="Abrufdatum"> Abgerufen am 30. Dezember 2019</span>.</span><span style="display: none;" class="Z3988" title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adc&rfr_id=info%3Asid%2Fde.wikipedia.org%3AOpenAPI&rft.title=OpenAPI-Editor+f%C3%BCr+Visual+Studio+Code&rft.description=OpenAPI-Editor+f%C3%BCr+Visual+Studio+Code&rft.identifier=https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3D42Crunch.vscode-openapi"> </span></span>

</li>

<li id="cite_note-7"><span class="mw-cite-backlink"><a href="#cite_ref-7">↑</a></span> <span class="reference-text"><span class="cite"><a rel="nofollow" class="external text" href="https://marketplace.eclipse.org/search/site/OpenAPI"><i>OpenAPI-Tools für Eclipse.</i></a><span class="Abrufdatum"> Abgerufen am 30. Dezember 2019</span>.</span><span style="display: none;" class="Z3988" title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adc&rfr_id=info%3Asid%2Fde.wikipedia.org%3AOpenAPI&rft.title=OpenAPI-Tools+f%C3%BCr+Eclipse&rft.description=OpenAPI-Tools+f%C3%BCr+Eclipse&rft.identifier=https%3A%2F%2Fmarketplace.eclipse.org%2Fsearch%2Fsite%2FOpenAPI"> </span></span>

</li>

</ol></div><div><div class="zim-footer">

Dieser Artikel wurde von <a class="external text" title="Zuletzt bearbeitet am 2025-05-23" href="https://de.wikipedia.org/wiki/?title=OpenAPI&oldid=256276553">Wikipedia</a> herausgegeben. Der Text ist unter <a class="external text" href="https://creativecommons.org/licenses/by-sa/4.0/deed.de">Creative Commons Attribution-Share Alike 4.0</a> verfügbar, sofern nicht anders angegeben. Für die Mediendateien können zusätzliche Bedingungen gelten.

</div>

</div></div>

</div>

</main>

</div>

</body></html>